Obtain the Result of a Document Signature Process

Alias

SignerProcessResultReading

Description

Obtains the result of a document signature process.

Request

GET /trustedx-resources/esignsp/v2/signer_processes/{signature_process_id}/result

Parameters

Name

Type

Usage

Description

signature_process_id

path

Required

Identifier of the document signature process whose result is to be obtained.

Authorization

The request must contain a bearer access token generated by an authorization server of the platform. This token must have a scope that includes the urn:safelayer:eidas:sign:process:document value and must be used as explained in RFC 6750. Basically, the access token must be included in an Authorization header as follows:

Authorization: Bearer <token>

The access token must be obtained via a client credentials grant type OAuth 2.0 flow.

Response

Status-Line

If the result of the signature process is obtained successfully, the HTTP response will contain the following Status-Line (see HTTP Response Status for all the possible cases).

HTTP/1.1 200 OK

Value

Description

HTTP/1.1 200 OK

The result of the signature process was successfully obtained and provided in the body of the response.

HTTP/1.1 404 Not Found

The result of the signature process could not be obtained because the process had not yet finished .

HTTP/1.1 410 Gone

The result of the signature process could not be obtained because the process does not exist .

Content-Type Header

Content-Type: application/json

Body

If the operation is performed successfully, the body contains a JSON object with the following structure

{
"status": {string},
"details": {
"message": {string}
}
}

Property

Usage

Description

status

Required

Result of the document signature process:

  • "finished": The process finished after all the documents were correctly signed.

  • "failed": The process finished but no document was signed owing to an error.

  • "failed_documents": The process finished. Some of the documents were signed, but not all.

  • "canceled": The process finished but no document was signed because the process was canceled.

details.message

Optional

Additional information on the result of the document signature process.